HipAssetsBinding

Undocumented in source.
version(ScriptAPI)
class HipAssetsBinding {}

Members

Classes

Array2D_GC (from hip.util.data_structures)
class Array2D_GC(T) via public import hip.util.data_structures : Array2D, Array2D_GC;
Undocumented in source but is binding to an external library. You might be able to learn more by searching the web for its name.

Static variables

addOnCompleteHandler
void function(IHipAssetLoadTask task, void delegate(IHipAsset) onComplete) addOnCompleteHandler;

Reserved for deferred loading. Use it on your own risk.

awaitLoad
void function() awaitLoad;

Stops the code from running and awaits asset manager to finish loading

createTextureRegion
IHipTextureRegion function(IHipTexture texture, float u1 = 0, float v1 = 0, float u2 = 1, float v2 = 1) createTextureRegion;

Used for manually creating texture regions. This is used by the game code abstraction.

createTilemap
IHipTilemap function(uint width, uint height, uint tileWidth, uint tileHeight, bool isInfinite = false) createTilemap;

Used for creating procedurally generated Tilemap:

getAsset
IHipAsset function(string name) getAsset;
Undocumented in source but is binding to an external library. You might be able to learn more by searching the web for its name.
getStringAsset
string function(string name) getStringAsset;
Undocumented in source but is binding to an external library. You might be able to learn more by searching the web for its name.
isLoading
bool function() isLoading;

Returns whether asset manager is loading anything

loadAudio
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadAudio;

Loads an in memory audio clip

loadCSV
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadCSV;

Usage:

loadFile
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadFile;

File reading wrapped in asset manager.

loadFont
IHipAssetLoadTask function(string path, int fontSize = 48, string f = __FILE__, size_t l = __LINE__) loadFont;
Undocumented in source but is binding to an external library. You might be able to learn more by searching the web for its name.
loadINI
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadINI;

Usage:

loadImage
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadImage;

Returns a load task for image

loadJSONC
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadJSONC;

Usage:

loadTexture
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadTexture;

Returns a load task for texture

loadTextureAtlas
IHipAssetLoadTask function(string atlasPath, string texturePath = ":IGNORE", string f = __FILE__, size_t l = __LINE__) loadTextureAtlas;

Returns a load task for a texture atlas If ":IGNORE" is provided for texturePath, the following behavior will occur: - .json: Will try to load a file with same name but with extension .png - .atlas: texturePath is always ignored - .txt(or any): Load a file with same name but extension .png - .xml: Ignore internal texture path to try file with same name but .png extension

loadTilemap
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadTilemap;

Returns a load task for tilemap

loadTileset
IHipAssetLoadTask function(string path, string f = __FILE__, size_t l = __LINE__) loadTileset;

This function is used in conjunction usually with createTilemap. loadTileset is a way of loading an externally defined tileset for your procedural map. Use loadTilemap when you have a complete map which you wish to load.

tilesetFromAtlas
IHipTileset function(IHipTextureAtlas atlas) tilesetFromAtlas;
Undocumented in source but is binding to an external library. You might be able to learn more by searching the web for its name.
tilesetFromSpritesheet
IHipTileset function(Array2D_GC!IHipTextureRegion spritesheet) tilesetFromSpritesheet;
Undocumented in source but is binding to an external library. You might be able to learn more by searching the web for its name.

Structs

Array2D (from hip.util.data_structures)
struct Array2D(T) via public import hip.util.data_structures : Array2D, Array2D_GC;

By using Array2D instead of T[][], only one array instance is created, not "n" arrays. So it is a lot faster when you use that instead of array of arrays.

Meta